/***************************************************************************//**
 * @file ad9508.h
 * @brief Header file of AD9508 Driver.
 * @author DHotolea (dan.hotoleanu@analog.com)
 ********************************************************************************
 * Copyright 2020(c) Analog Devices, Inc.
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * - Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in
 * the documentation and/or other materials provided with the
 * distribution.
 * - Neither the name of Analog Devices, Inc. nor the names of its
 * contributors may be used to endorse or promote products derived
 * from this software without specific prior written permission.
 * - The use of this software may or may not infringe the patent rights
 * of one or more patent holders. This license does not release you
 * from the requirement that you obtain separate licenses from these
 * patent holders to use this software.
 * - Use of the software either in source or binary form, must be run
 * on or directly connected to an Analog Devices Inc. component.
 *
 * THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES "AS IS" AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, NON-INFRINGEMENT,
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL ANALOG DEVICES BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, INTELLECTUAL PROPERTY RIGHTS, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *******************************************************************************/
#ifndef AD9508_H_
#define AD9508_H_

/******************************************************************************/
/***************************** Include Files **********************************/
/******************************************************************************/
#include "spi.h"

/******************************************************************************/
/********************** Macros and Constants Definitions **********************/
/******************************************************************************/

#define AD9508_SPI_CONFIG				    0x000
#define AD9508_PART_ID_LOW				    0x00C
#define AD9508_PART_ID_HIGH				    0x00D
#define AD9508_OUT1_DIV_RATIO_LOW			    0x01B
#define AD9508_OUT1_DIV_RATIO_HIGH			    0x01C
#define AD9508_OUT1_PHASE_LOW			   	    0x01D
#define AD9508_OUT1_PHASE_HIGH			   	    0x01E
#define AD9508_PART_ID_VALUE			   	    0x005
#define AD9508_DIVIDE_RATIO_ONE			   	    0x000

/******************************************************************************/
/*************************** Types Declarations *******************************/
/******************************************************************************/

struct ad9508_init_param {
	/* SPI */
	struct spi_init_param	spi_init;
};

struct ad9508_dev {
	/* SPI */
	struct spi_desc	*spi_desc;
};

/******************************************************************************/
/************************ Functions Declarations ******************************/
/******************************************************************************/

int32_t ad9508_reg_read(struct ad9508_dev *dev, uint16_t reg_addr,
			uint8_t *reg_data);

int32_t ad9508_reg_write(struct ad9508_dev *dev, uint16_t reg_addr,
			 uint8_t reg_data);

int32_t ad9508_setup(struct ad9508_dev **device,
		     const struct ad9508_init_param *init_param);

int32_t ad9508_remove(struct ad9508_dev *dev);

#endif
